home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / opus / obank200.zip / OBANK.DOC next >
Text File  |  1992-10-19  |  16KB  |  569 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                   OBank 2.00
  20.  
  21.                                  
  22.                            Time Banking for Opus 1.7x
  23.  
  24.  
  25.  
  26.  
  27.              Copyright(c) 1991, Erik Likvarn, All Rights Reserved.
  28.  
  29.  
  30.  
  31.                 Direct all comments/suggestions to Erik Likvarn
  32.  
  33.                            Wombat BBS! +61-2-550-4336
  34.  
  35.                             3:712/316    FidoNet.Org
  36.  
  37.              Documentation Adopted & Rewritten by Michael T. MacLeod
  38.  
  39.                             Doc's Place 615-282-9468
  40.  
  41.                             1:3642/701   FidoNet.Org
  42.                             
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.     INTRODUCTION
  74.  
  75.     OBank is a time bank utility for Opus 1.7x.  It allows the user to
  76.     store unused time for later.  This makes the Opus `Upload Refund'
  77.     option even more useful than it currently is, as now the user may
  78.     store `credits' for use at a more opportune time.
  79.  
  80.     You the SysOp do still have control, as you can use the
  81.     configuration file to specify how many minutes a user may deposit or
  82.     withdraw per day based upon his/her privilege level.
  83.  
  84.     OBank was written entirely in Borland Turbo Pascal 5.5, using the
  85.     Borland Turbo Access Database Toolbox 4.0.  There is no `practical'
  86.     limit to how many users may use OBank, as the database can maintain
  87.     over 2 billion records and automatically re-uses erased records.
  88.  
  89.     OBank is very easy to install: all you need is to edit the
  90.     configuration file, set the environment variable, change your
  91.     BBS.CTL file to include OBank on your menu, and ensure Opus re-reads
  92.     LASTUSER.DAT on return from `Outside'.
  93.  
  94.  
  95.     LICENSE
  96.  
  97.     OBank is FREE, but I retain copyright on this software.  You are
  98.     granted a limited license to use OBank as you see fit.
  99.  
  100.     However:
  101.  
  102.         (1) You may not distribute OBank other than with the contents of
  103.             its original archive unchanged.  You may, however, change the
  104.             archive format according to your needs, provided all the
  105.             original files are kept intact and together.
  106.  
  107.         (2) You may not charge any money for OBank.  This prohibition
  108.             includes copying fees, but it does not cover the initial
  109.             cost of the supply floppy disk.
  110.  
  111.  
  112.  
  113.     NO WARRANTY
  114.  
  115.     There is no warranty attached to this software.  It is guaranteed to
  116.     do nothing except occupy space on your hard drive, in most instances
  117.     this is not guaranteed either.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.     Quick Install:         Warning! for Grizzled Opus Veterans only.
  140.  
  141.         STEP 1
  142.         ------
  143.  
  144.         OK! Here goes for all of the impatient people, who absolutely
  145.     refuse to read the DOC's first. [Grin]  Unpack OBank to a directory
  146.     of your choosing. Edit the OBANK.INI file to reflect the settings of
  147.     your system, ie. ( C:\OPUS\SYSTEM\LASTUS01.DAT ).
  148.  
  149.         STEP 2
  150.         ------
  151.  
  152.         Next, Edit your BBS.PRM file menu section(s) you wish OBank to be
  153.     accessed from by using the _OUTSIDE  "OBank!" =RUN ?:\????\OBank.EXE
  154.     method, ( make sure SECURE is set to 3 ), and reSALT your parm file
  155.     with NACL.
  156.  
  157.         STEP 3
  158.         ------
  159.  
  160.         Last, but not least logon to Opus and See if you got it right the
  161.     first time (HeHe Probably not), If you made a mistake all you have to
  162.     do is start at step 1, ( Of course there is always the DOC's ) [Grin].
  163.     Dont forget to put a SET OBANK=?:\????\OBANK.INI in your Autoexec.bat!
  164.  
  165.  
  166.     HOW IT WORKS!
  167.  
  168.  
  169.     COMMAND LINE
  170.  
  171.     OBank should be run from the Opus menu.  There are only two command
  172.     line parameters:
  173.  
  174.         -k....Use local mode.   (This is usually not necessary as OBank
  175.                                  will detect local mode from
  176.                                  LASTUSER.DAT.)
  177.  
  178.         -txx..Task Number.      (This parameter is not necessary if you
  179.                                  have only one task running.)
  180.  
  181.     Both of the above parameters are passed automatically by Opus when
  182.     using the _OUTSIDE RUN option.
  183.  
  184.     These Doc's have been formatted for the DOS 5.0 {PRINT} command, so
  185.     at any time you wish to read the Doc's just turn on that Gadget with
  186.     the DUST all over it (you know the plastic box next to your computer)
  187.     <Grin> and print them out.
  188.  
  189.                                        Narrator over and out!
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.     ENVIRONMENT VARIABLE
  206.  
  207.     OBank requires that you set an environment variable pointing to
  208.     where its configuration file is kept. Insert the following line into
  209.     your AUTOEXEC.Bat or NERF.BAT files:
  210.  
  211.                 SET OBANK=C:\OPUS\BIN\OBANK.INI
  212.  
  213.             (Obviously you should specify the correct path,
  214.                     not the one in the example.)
  215.  
  216.     You are able to specify non task specific information in OBANK.INI,
  217.     so you can use the same config file for all tasks.
  218.  
  219.     OPUS
  220.  
  221.     You need to tell Opus to re-read the LASTUSER.DAT file after
  222.     returning from `Outside'.  Simply edit your BBS.CTL file to reflect
  223.     this by changing the SECURE parameter setting to 3.
  224.  
  225.     You need also to include OBank on your menu.  Decide which menu
  226.     you'd like to add it to, and edit its entry in BBS.CTL.  Insert the
  227.     following line.
  228.  
  229.         _OUTSIDE    Normal  "OBank" = RUN c:\opus\bin\obank.exe
  230.  
  231.             (You should specify the actual path you are using,
  232.                 not the one in the example.)
  233.  
  234.     Opus will provide all the necessary parameters if it is run in this
  235.     way.
  236.  
  237.     After making these changes you will need to re-compile your BBS.CTL
  238.     using NACL.EXE.  Check the Opus Technical Reference for more
  239.     information on editing Opus menus.
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.     CONFIGURATION FILE
  272.  
  273.     In the configuration file, you must specify:
  274.  
  275.         1). How many minutes a user may deposit or withdraw in a single day.
  276.         2). Where the OBank data files should be kept.
  277.         3). Where LASTUSER.DAT is kept.
  278.         4). Where it should write its log.
  279.         5). How many languages are installed in your setup
  280.             and what sets of prompts to use for each language.
  281.  
  282.     The configuration file now uses a format quite similar to that used
  283.     by Windows.  It has a series of "sections" denoted by square
  284.     brackets enclosing the section name. e.g. [Section].  These are
  285.     followed by the section's settings directly beneath. There are at
  286.     least five sections in OBANK.INI, they are:
  287.     [Paths], [MaxDeposit], [MaxWithdraw], [Language], [English].
  288.     There could be more, however, if you specify more languages.
  289.  
  290.     The Paths section has three settings:
  291.  
  292.         LogFile=Fully qualified drive:\path\filename.ext of the log file
  293.         LastUserPath=Fully qualified drive:\path\ to LASTUSER.DAT
  294.  
  295.         NOTE:   You may use #'s to substitute task numbers in path and
  296.                 filenames for LastUserPath and LogFile if you like.
  297.                     e.g.
  298.                     if task is set to 1 then
  299.                     c:\opus\logs\opus##.log = c:\opus\logs\opus01.log
  300.                     c:\opus\logs\opus#.log = c:\opus\logs\opus1.log
  301.  
  302.         OBankData=Fully qualified drive:\path\ to OBank.DAT/IDX
  303.  
  304.         NOTE:   Don't forget to use a trailing backslash '\' on the ends
  305.                 of paths, or OBank will say nasty things about you! <G>
  306.  
  307.     OBank uses the same type of log format as Opus, so it won't look
  308.     untidy if you let it share.
  309.  
  310.     The MaxDeposit and MaxWithdraw sections allow you to specify the
  311.     maximum amount of time that may be transacted in a single day, based
  312.     on privilege level.  Simply alter the setting next to each
  313.     privilege level to reflect the maximum number of minutes allowed.
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.     The Language section is where you specify which languages are
  338.     installed on your system.  You may specify up to 12 languages.
  339.     The settings are in the form Lang01=English.
  340.     This says to OBank that language number 1 is called English.
  341.     The language numbers must correspond to the language numbers you
  342.     have set in your BBS.CTL file.  If you have said to Opus that
  343.     language 5 is Swahili then in the language section of OBANK.INI you
  344.     should set Lang05=Swahili.
  345.  
  346.     Each language then has its own section.  The English section is
  347.     already defined (You gotta have one, so it may as well be mine :-))
  348.  
  349.     For each language added you need to specify a few things.  There are
  350.     24 settings for each language specified.  If you have specified a
  351.     language on Opus, then you MUST specify a set of identifiers for
  352.     each of them here.  There are NO defaults.  If you don't set it up,
  353.     there will be crap all over the screen :-)
  354.  
  355.     There are six field identifiers, five menu items, four prompts, four
  356.     help descriptions, three error messages and two status messages. You
  357.     have to set ALL of them for each language, there are NO defaults.
  358.  
  359.     The Field Identifiers are:
  360.  
  361.         FieldName=      How ever you want to say "User Name"
  362.         FieldRemain=    How ever you want to say "Remaining Online Time"
  363.         FieldDeposit=   How ever you want to say "Today's Deposits"
  364.         FieldWithdraw=  How ever you want to say "Today's Withdrawals"
  365.         FieldBalance=   How ever you want to say "OBank Balance"
  366.         FieldMinutes=   How ever you want to say "minutes"
  367.  
  368.     The Menu items are:
  369.  
  370.         MenuDeposit=    How ever you want to say "Deposit"
  371.         MenuWithdraw=   How ever you want to say "Withdraw"
  372.         MenuExit=       How ever you want to say "Exit"
  373.         MenuHelp=       How ever you want to say "?Help"
  374.  
  375.     The MenuExit prompt is more interesting for asthetic reasons.  If
  376.     you run OBank from the Main Menu of Opus you can change it to say
  377.     Main Menu instead of Exit.  Or, of course, whatever menu you run it
  378.     from.  It sort of makes OBank more a part of Opus than a mere
  379.     hanger on :-).
  380.  
  381.     Remember! On HiTech menus, only the first word is used if a space
  382.     follows it, so make sure its something meaningful.  Of course all the
  383.     menu prompts must have a unique first letter.
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.     The Prompts are:
  404.  
  405.         PromptSelect=       How ever you want to say "Select:"
  406.         PromptPressEnter=   How ever you want to say
  407.                                 "Press Enter to Continue ..."
  408.         PromptDeposit=      How ever you want to say
  409.                                 "Deposit how much (max 10 mins) ?"
  410.  
  411.         PromptWithdraw=     How ever you want to say
  412.                                 "Withdraw how much (max 10 mins) ?"
  413.  
  414.     The Help Descriptions are:
  415.  
  416.         HelpWithdraw=       A one line description of the withdraw function.
  417.         HelpDeposit=        A one line description of the deposit function.
  418.         HelpExit=           A one line description of the exit function.
  419.         HelpHelp=           A one line description of the help function.
  420.  
  421.     The Error Message area:
  422.  
  423.         ErrorBadNumber=     The message that should appear when the user
  424.                             does not type a number, when requested to
  425.                             specify an amount of minutes.
  426.  
  427.         ErrorExceedLimit=   The message that should appear if the user
  428.                             is trying to deposit or withdraw more than
  429.                             the specified daily limit for his privilege
  430.                             level.
  431.  
  432.         ErrorNoTime=        The message that should appear when the user
  433.                             wishes to withdraw more time than is stored,
  434.                             or deposit more time than is remaining.
  435.  
  436.     The Status Messages are:
  437.  
  438.         StatusDeposit=      A message confirming to the user that he has
  439.                             deposited an amount of time into his
  440.                             account. 
  441.  
  442.         StatusWithdraw=     A message confirming to the user that he has
  443.                             withdrawn an amount of time from his
  444.                             account.
  445.  
  446.         For both of the above status messages, you may insert a %m where
  447.         the amount in minutes should appear)
  448.  
  449.     Simple eh?   Yeah sure it is!  So is configuring a multiline syetem!
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.     That's OBank up and running, now a bit about it's companion
  471.     utilities.
  472.  
  473.     OBEDIT
  474.  
  475.     OBEdit is an OBank utility.  It allows you to browse and edit the
  476.     time database.  Its operation also relies upon the environment
  477.     variable and configuration file.  You can browse through the
  478.     database, or search for a user record but currently only for an
  479.     exact match on user name.  You can change the amount of time stored
  480.     in an account or you can erase accounts altogether.
  481.  
  482.     OBEdit re-indexes the time database each time it is started up.
  483.     Any records which you have deleted will be permanently purged.
  484.  
  485.     OBEdit's operation is quite simple and fairly self explanatory.  I
  486.     think you'll see what I mean when you run it.
  487.  
  488.  
  489.     OBPURGE
  490.  
  491.     OBPurge is a utility to allow you to automatically erase unused
  492.     account, based upon the time since they where last used.  It also
  493.     requires that the environment variable be set and has its own
  494.     section in OBANK.INI with two settings.  They are:
  495.  
  496.             DaysInactive=   The number of days of inactivity before
  497.                             OBPurge will erase the account.
  498.  
  499.             LogFile=        A log file for It to report what it's doing.
  500.                             Unlike OBank's log setting, it does not
  501.                             automatically insert task numbers into this
  502.                             line.  You must specify a real path and
  503.                             filename.
  504.  
  505.     You can run OBPurge as a daily/weekly event, and it will just keep
  506.     the size of the database down, and help speed up on-line searches.
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.     PROPOSED ENHANCEMENTS
  536.  
  537.     OBank currently does not make allowance for system events:  it will
  538.     allow a user to withdraw enough time to over-run an event,
  539.     unfortunately Opus will still not allow them to do this if it has
  540.     already limited their time.
  541.     Erik plans to implement checking to stop this from happening.
  542.  
  543.     Erik also plans to investigate a new feature He saw recently on a
  544.     GT-Power BBS where users were granted a minute at a time for each
  545.     message they read.  He is always looking for new ways to encourage
  546.     users to read instead of download.  This feature may be a toughy but
  547.     He'd like to do something along these lines.
  548.  
  549.  
  550.     FINALLY
  551.  
  552.     We hope you all like OBank, if you'd like to show your appreciation,
  553.     don't send money - send a post card to:
  554.  
  555.                         E. Likvarn.
  556.                         P.O. Box 190,
  557.                         Westgate. N.S.W. 2048.
  558.                         AUSTRALIA.
  559.  
  560.     I'm SURE Erik would LOVE to here from you!
  561.  
  562.     That's about it from me,
  563.  
  564.     Any suggestions for correcting TYPO'S or mistakes in the DOC'S should be
  565.     submitted to Michael T. MacLeod via NetMail.
  566.  
  567.     1:3642/701 @FidoNet.Org
  568.     
  569.